
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>lmp.track_particles &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="lmp.local_coords" href="lmp.local_coords.html" />
    <link rel="prev" title="lmp.entrainment" href="lmp.entrainment.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="lmp-track-particles">
<h1>lmp.track_particles<a class="headerlink" href="#lmp-track-particles" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="lmp.track_particles">
<code class="sig-prename descclassname">lmp.</code><code class="sig-name descname">track_particles</code><span class="sig-paren">(</span><em class="sig-param">q0_local</em>, <em class="sig-param">q1_local</em>, <em class="sig-param">md</em>, <em class="sig-param">particles</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/lmp.html#track_particles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lmp.track_particles" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the forcing variables needed to track particles</p>
<p>The independent variable in the Lagrangian plume model is t for advection
of the continuous phase.  Because the particles slip through the fluid, 
their advection speed is different; hence, all particle equations have 
a different independent variable for their time, tp.  Also, particle 
motion is computed in the local plume coordinates space (l,n,m); thus,
the vertical slip velocity needs to be transformed to the local plume
coordinate system.  Finally, the entrainment velocity pointing toward
the plume centerline needs to be evaluated, based on the distance the 
particle is from the plume centerline.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>q0_local</strong><span class="classifier"><cite>bent_plume_model.LagElement</cite></span></dt><dd><p>Object containing the numerical solution at the previous time step</p>
</dd>
<dt><strong>q1_local</strong><span class="classifier"><cite>bent_plume_model.LagElement</cite></span></dt><dd><p>Object containing the numerical solution at the current time step</p>
</dd>
<dt><strong>md</strong><span class="classifier">float</span></dt><dd><p>Total entrainment into the Lagrangian element (kg)</p>
</dd>
<dt><strong>particles</strong><span class="classifier">list of <cite>Particle</cite> objects</span></dt><dd><p>List of <cite>bent_plume_model.Particle</cite> objects containing the dispersed 
phase local conditions and behavior.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>fe</strong><span class="classifier">float</span></dt><dd><p>Entrainment frequency (1/s)</p>
</dd>
<dt><strong>up</strong><span class="classifier">ndarray</span></dt><dd><p>Slip velocity for each particle projected on the local plume 
coordinate system (l,n,m) (m/s).  Each row is for a different 
particle and the columns are for the velocity in the (l,n,m)
direction.</p>
</dd>
<dt><strong>dtp_dt</strong><span class="classifier">ndarray</span></dt><dd><p>Differential particle transport time to continuous phase transport
time evaluated from the previous time step to the current time 
step (–).</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
      <li>Previous: <a href="lmp.entrainment.html" title="previous chapter">lmp.entrainment</a></li>
      <li>Next: <a href="lmp.local_coords.html" title="next chapter">lmp.local_coords</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/bpm/lmp.track_particles.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>